<?xml version="1.0" encoding="ISO-8859-15"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" >

<head>
<link rel="stylesheet" href="gadgets.css" type="text/css" />

<title>Polar Area Diagram</title>
</head>

<body>


<h1 class="title">Liquid Diagrams</h1>

<p class="title">
&copy;2010 Martin Lessacher<br/>
</p>


<h2 class="title">Polar Area Diagram</h2>

<p>The Polar Area Diagram dates back to Florance Nightingale [1858] a british nurse who used statistical graphics to 
illustrate how the Sanitary Commission that was sent out during the war dramatically reduced the death rate.</p>

<p>The original diagram is divided into twelve parts which are equally spaced around a circle. Data values are drawn by overlapping wedges. 
In order to see all of the wedges, smaller values are drawn on top of the bigger ones.</p>

<br />
	<a href="images/polararea.png"><img class="center" src="images/polararea.png" alt="The Liquid Diagrams Polar Area visualisation." width="650" height="350"/></a>
<br />
<br/>

<h2 class="title">Features</h2>

<b>Changing the colours of entities</b><br/>
<p>Initially the colours used in a visualisation depend on the chosen colour scheme. Colour schemes
are colour palettes that define a limited amount of colours that are used in a visualisation. The 
colour schemes where taken from <a href="http://de-de.colourlovers.com">COLOURLovers</a>. If a colour scheme has
less colours defined than entities are present in a data set the colours are repeated.</p>

<p>All colours used to draw entities can be changed by using a colour picker. To change the colour of a specific entity the user has to
click on the colour rectangle, representing the entities colour, in the legend panel. This will bring
up the colour picker. After selecting the colour the selection is verified with the Ok button and the
colour is immediately assigned to the entity.</p><br/>

<b>Changing fonts</b><br/>
<p>All the fonts used in the visualisations can be replaced by other fonts. To do this the user has to switch
to the "Font" panel in the options and choose a font colour, size and type for the desired font 
category. When using the corresponding buttons it is possible to set the font style to bold, italic and 
underline. The selected fonts are loaded on runtime into the gadget.</p><br/>

<b>Hide single entities</b><br/>
<p>Entities can be hidden by clicking on an entities name in the legend panel while holding down the
ALT key. Clicking once more will show the entity again.</p><br/>

<b>Changing diagram titles</b><br/>
<p>The user can dynamically alter the diagram title, the x-axis title, and the y-axis tile by clicking on
the appropriate label. A text box will then appear to enter the new title. The edit process is finished
by confirming the changes with the enter key.</p><br/>

<b>Transpose the data</b><br/>
<p>All Liquid Diagrams Gadgets offer a function to transpose data. This is especially useful if the
data is in the wrong format and it would take several minutes to transpose it by using other applications.
For example Google Docs the only external data source currently available does not
have a function to transpose the data. The transpose option is available among the gadget settings
(almost at the bottom of the gadget options frame) when adding the gadget to the spreadsheet.</p><br/>

<b>Interactively changing gadget settings</b><br/>
<p>Using Google Docs it is not possible to change the gadget settings without losing all changes that
have been made in the visualisation. That means if changes like filters, swapped axes, hidden
data,... have been made they will be reset when changing the gadget parameters with the default
Google gadget settings. This is due to the fact that a new gadget request is sent by Google and the
visualisation is created once again.</p>

<p>Using the Options Panel the user is able to change the parameters dynamically while
exploring the data. This is done through a separate gadget settings menu displayed to the left side
of the visualisation.</p><br/>
<br/>

<h2 class="title">Data Format</h2>
<p>The data format of this visualisation can be seen in the <a href="dataformats.html#nightingale">data formats document</a>.</p>
<br /><br />

<h2 class="title">Parameter List</h2>

<table width="1290" border="1">
  <tr>
    <td width="65" align="center">Number</td>
    <td width="225" align="left">Parameter</td>
    <td width="98" align="center">Type</td>
    <td width="163" align="center">Options</td>
    <td width="705" align="left">Description</td>
  </tr>
  <tr>
    <td align="center">1</td>
    <td align="left">X-Size</td>
    <td align="center">Number</td>
    <td align="center"></td>
    <td align="left">The x-size available to the gadget.</td>
  </tr>
  <tr>
    <td align="center">2</td>
    <td align="left">Y-Size</td>
    <td align="center">Number</td>
    <td align="center"></td>
    <td align="left">The y-size available to the gadget.</td>
  </tr>
  <tr>
    <td align="center">3</td>
    <td align="left">Show Label</td>
    <td align="center">Boolean</td>
    <td align="center">true | false</td>
    <td align="left">Show or hide the name label of each data set.</td>
  </tr>
  <tr>
    <td align="center">4</td>
    <td align="left">Legend</td>
    <td align="center">String</td>
    <td align="center">No Legend | Horizontal | Vertical</td>
    <td align="left">Determines the legend position.</td>
  </tr>
  <tr>
    <td align="center">5</td>
    <td align="left">Title</td>
    <td align="center">String</td>
    <td align="center"></td>
    <td align="left">Diagram Title - displayed above the visualisation.</td>
  </tr>
  <tr>
    <td align="center">6</td>
    <td align="left">Fill Alpha</td>
    <td align="center">Number</td>
    <td align="center"></td>
    <td align="left">Alpha value of the filled areas.</td>
  </tr>
  <tr>
    <td align="center">7</td>
    <td align="left">Radius</td>
    <td align="center">Number</td>
    <td align="center">1-100</td>
    <td align="left">The desired radius of the pie. The value needs to be entered in percent based on the available diagram space.</td>
  </tr>
  <tr>
    <td align="center">8</td>
    <td align="left">Number Display Format</td>
    <td align="center">String</td>
    <td align="center">No Formatting | 1,000.00 | 1.000,00</td>
    <td align="left">Defines how numbers are to be displayed within the diagram.</td>
  </tr>
  <tr>
    <td align="center">9</td>
    <td align="left">Number Input Format</td>
    <td align="center">String</td>
    <td align="center">No Formatting | 1,000.00 | 1.000,00</td>
    <td align="left">Determines the format in which the supplied data is formatted.</td>
  </tr>
  <tr>
    <td align="center">10</td>
    <td align="left">Show Ranges</td>
    <td align="center">Boolean</td>
    <td align="center">true | false</td>
    <td align="left">Show axis ranges.</td>
  </tr>
  <tr>
    <td align="center">11</td>
    <td align="left">Host URL</td>
    <td align="center">String</td>
    <td align="center"></td>
    <td align="left">URL of the gadget. There needs to be a colour scheme file available at "./common/color-schemes.xml" or the standard colour scheme will be used. 
The precompiled font files which can be loaded on runntime have to be stored in "./common/fonts/".</td>
  </tr>
  <tr>
    <td align="center">12</td>
    <td align="left">Show Title</td>
    <td align="center">Boolean</td>
    <td align="center">true | false</td>
    <td align="left">Show or hide the diagram title.</td>
  </tr>
  <tr>
    <td align="center">13</td>
    <td align="left">Use Ratio</td>
    <td align="center">Boolean</td>
    <td align="center">true | false</td>
    <td align="left">Determines whether to use a custom display ratio or not. If yes, x-ratio and y-ratio need to be supplied also.</td>
  </tr>
  <tr>
    <td align="center">14</td>
    <td align="left">X-Ratio</td>
    <td align="center">Number</td>
    <td align="center"></td>
    <td align="left">Width ratio factor.</td>
  </tr>
  <tr>
    <td align="center">15</td>
    <td align="left">Y-Ratio</td>
    <td align="center">Number</td>
    <td align="center"></td>
    <td align="left">Height ratio factor.</td>
  </tr>
  <tr>
    <td align="center">16</td>
    <td align="left">Show Wedge Border</td>
    <td align="center">Boolean</td>
    <td align="center">true | false</td>
    <td align="left">Enables the displaying of wedge borders.</td>
  </tr>
  <tr>
    <td align="center">17</td>
    <td align="left">Wedge Border Thickness</td>
    <td align="center">Number</td>
    <td align="center"></td>
    <td align="left">Determines the thickness of the wedge borders.</td>
  </tr>
  <tr>
    <td align="center">18</td>
    <td align="left">Show Axes</td>
    <td align="center">Boolean</td>
    <td align="center">true | false</td>
    <td align="left">Determines if the axes are displayed.</td>
  </tr>
  <tr>
    <td align="center">19</td>
    <td align="left">Inner Radius Offset</td>
    <td align="center">Number</td>
    <td align="center"></td>
    <td align="left">Amount of inner radius offset from centre.</td>
  </tr>
  <tr>
    <td align="center">20</td>
    <td align="left">Show Filters</td>
    <td align="center">Boolean</td>
    <td align="center">true | false</td>
    <td align="left">Show filters to filter data at each axis according to its minimum and maximum filters.</td>
  </tr>
  <tr>
    <td align="center">21</td>
    <td align="left">Show Filter Labels</td>
    <td align="center">Boolean</td>
    <td align="center">true | false</td>
    <td align="left">Show filter labels, indicating each filters value.</td>
  </tr>
  <tr>
    <td align="center">22</td>
    <td align="left">Range Label Style</td>
    <td align="center">String</td>
    <td align="center">None | Right | Above | Beneath</td>
    <td align="left">Determines the position and style of the range labels.</td>
  </tr>
  <tr>
    <td align="center">23</td>
    <td align="left">Axis Label Direction</td>
    <td align="center">String</td>
    <td align="center">Horizontal | Rotated | Vertical</td>
    <td align="left">Sets the direction of the axis labels.</td>
  </tr>
  <tr>
    <td align="center">24</td>
    <td align="left">Date Value</td>
    <td align="center">Boolean</td>
    <td align="center">true | false</td>
    <td align="left">Enables the use of the different date formats.</td>
  </tr>
  <tr>
    <td align="center">25</td>
    <td align="left">Date Format</td>
    <td align="center">String</td>
    <td align="center">2000-01-30 | 30 Jan 2000 | 30-01-2000 | 30/01/2000 | 30.01.2000 | 01-30-2000 | 01/30/2000 |
 01.30.2000 | 2000/01/30 | 2000.01.30 | Jan | 2000 | 01-2000 | 01.2000 | 01/2000 | 2000-01 | 2000.01 | 2000/01 |
 Jan 2000 | 30th January 2000 </td>
    <td align="left">Sets all dates in the visualization according to the specified format.</td>
  </tr>
  <tr>
    <td align="center">26</td>
    <td align="left">Axis Starting Rotation</td>
    <td align="center">Number</td>
    <td align="center"></td>
    <td align="left">Determines the rotation of the axes.</td>
  </tr>
  <tr>
    <td align="center">27</td>
    <td align="left">Use Common Label Position</td>
    <td align="center">Boolean</td>
    <td align="center">true | false</td>
    <td align="left">Enables the common label position.</td>
  </tr>
  <tr>
    <td align="center">28</td>
    <td align="left">Common Label Position Radius</td>
    <td align="center">Number</td>
    <td align="center"></td>
    <td align="left">Determines the radius of the common label position.</td>
  </tr>

</table>

</body>
</html>
